[Issue #506] Allow linking between series #587
Conversation
andrepapoti
force-pushed
the
i506
branch
2 times, most recently
from
23d8645
to
a5f0cac
Compare
There was a problem hiding this comment.
Apologies for the delays getting this. I'll try to respond faster to future revisions. I have some minor nits in the docs but my bigger question is this: should this be a dedicated API, or could we allow this as part of a new update series API? For example:
PATCH /api/v1.4/series/1 HTTP/1.1
Content-Type: text/json
{
"related": [2, 3]
}This is what we do for patches now, so I wonder if there's any reason not to do the same for series?
(fwiw, I have a clear preference for sticking to RESTful APIs where possible, so I'm wondering what reason, if any, there is for not doing things that way 🙂)
docs/api/rest/index.rst
Outdated
| @@ -275,6 +275,7 @@ Supported Versions | |||
| 1.1, 2.1, ✓ | |||
| 1.2, 2.2, ✓ | |||
| 1.3, 3.1, ✓ | |||
| 1.4, 3.1, ✓ | |||
There was a problem hiding this comment.
| 1.4, 3.1, ✓ | |
| 1.4, 3.2, ✓ |
docs/api/rest/schemas/v1.3.rst
Outdated
| API v1.3 | ||
| ================= |
There was a problem hiding this comment.
| API v1.3 | |
| ================= | |
| API v1.3 | |
| ======== |
|
Also, we probably want to expose events for this? However, we should be careful not to avoid the pitfall encountered in related patches, namely that we returned the |
Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
For two series to be linked togheter they must belong to the same project Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
…eries' Ensure the retrival of series is keept at O(1) complexity. Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
|
@stephenfin updated the API to follow your suggestion. My initial idea was to not require the user to just send the new values instead of appending them to the previous |
Description
Allow linking between two series.
A new field called
related_serieswas added to theSeriesmodel where you can reference otherSeries. This feature is can be used to link different versions of the sameSeriesto easily build a version history.The linking of a
Seriesis bidirectional so if you link A to B automatically B is linked to A.For this feature a new API endpoint was created so the API version was bumped to v1.4.
Related
Closes #506